home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / scram_36.zip / SCRAMBLE.DOC < prev    next >
Text File  |  1992-06-06  |  15KB  |  383 lines
  1.  
  2.  
  3.                        ============================
  4.                              S C R A M B L E !
  5.                        ============================
  6.                          (C)1991,92 T&J SOFTWARE
  7.  
  8.         One of the T&J Software Collection of multi-BBS door programs.
  9.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  10.               UltraBBS, Telegard, TriBBS, Remote Access, and WWIV
  11.  
  12.                        VERSION 3.6      06/06/92
  13.  
  14.                                    By
  15.  
  16.                                Tom Wildoner
  17.                              397 West Broadway
  18.                               Jim Thorpe, PA
  19.                                   18229
  20.                             VOICE (717)325-9480
  21.  
  22.                                    From
  23.  
  24.                                The T&J BBS
  25.                               (717)325-9481
  26.                              12/24/9600/14400
  27.  
  28. LEGALITIES:
  29. ===========
  30.  
  31.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  32.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  33.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  34.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  35.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  36.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  37.       OR BREACH OF ANY WARRANTY.
  38.  
  39. SUPPORT:
  40. ========
  41.  
  42. Please feel free to call me at my BBS number or voice number. Word
  43. lists will be available on my BBS for download as they are prepared.
  44.  
  45. DISTRIBUTION:
  46. =============
  47.  
  48. You may make this file available for downloading from your BBS or you may
  49. upload it to any BBS of your choice, provided that you do not make any
  50. changes to the contents of the archive (ZIP file). The archive and its
  51. individual contents may not be used by any service that charges any money
  52. whatsoever, without the written permission of the author.
  53.  
  54. REGISTERING:
  55. ============
  56.  
  57. The tournament mode is disabled until registered. Scramble will only
  58. pick words from word list number one until registered. Scramble will
  59. only use the first 25 words from word list one until registered.
  60.  
  61. Once registered -- simply call T&J BBS to download a new KEY file and
  62. it will unlock all the features of the registered version including
  63. the full 2000+ word lists!
  64.  
  65. FEATURES:
  66. =========
  67.            --- Return to BBS on dropped carrier.
  68.            --- 4-minutes no activity will return to BBS.
  69.            --- Online Chat.
  70.            --- You can blank the display.
  71.            --- Dump user back to BBS.
  72.            --- Drop to DOS function.
  73.            --- Desqview Aware.
  74.            --- COM1-4 support and non-standard IRQ's.
  75.            --- Colorful ANSI screens.
  76.            --- Makes TOP TEN ANSI & ASCII bulletins.
  77.            --- NO BRUN module needed for play.
  78.            --- BETA tested on five different boards.
  79.            --- Use of HOT KEYS while in the door.
  80.            --- Support BBS available.
  81.            --- Easily RESET the entire program.
  82.            --- Self maintaining no maintenance required.
  83.            --- Door resets every month to give ALL players a chance.
  84.  
  85.  
  86. INSTALLATION:     IMPORTANT!!!!!!!
  87. ==================================
  88.  
  89. First run RESET program! This will reset all score and place the current
  90. month in the SYSOP.CFG file. This program only needs to run initially,
  91. or whenever you want to reset everything from scratch. To run the reset
  92. program simply type: SCRAM36 RESET
  93.  
  94. CONFIGURATION:
  95. =============
  96.  
  97. Example configuration file for PCBOARD.SYS
  98. ------------------------------------------
  99.  
  100. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  101. T&J Software        <=-  (Change this to your BBS name)
  102. Tom                 <=-  (The Sysop's first name)
  103. Wildoner            <=-  (The Sysop's last name)
  104.  
  105. Example configuration file for USERS.SYS
  106. ----------------------------------------
  107.  
  108. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  109. T&J Software        <=-  (Change this to your BBS name)
  110. Tom                 <=-  (The Sysop's first name)
  111. Wildoner            <=-  (The Sysop's last name)
  112.  
  113. Example configuration file for DOOR.SYS
  114. ---------------------------------------
  115.  
  116. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  117. T&J Software        <=-  (Change this to your BBS name)
  118. Tom                 <=-  (The Sysop's first name)
  119. Wildoner            <=-  (The Sysop's last name)
  120.  
  121. Example configuration file for USERINFO.DAT
  122. -------------------------------------------
  123.  
  124. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  125. T&J Software        <=-  (Change this to your BBS name)
  126. Tom                 <=-  (The Sysop's first name)
  127. Wildoner            <=-  (The Sysop's last name)
  128. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  129.  
  130. Example configuration file for CALLINFO.BBS
  131. -------------------------------------------
  132.  
  133. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  134. T&J Software        <=-  (Change this to your BBS name)
  135. Tom                 <=-  (The Sysop's first name)
  136. Wildoner            <=-  (The Sysop's last name)
  137.  
  138. Example configuration file for DORINFOx.DEF
  139. -------------------------------------------
  140.  
  141. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  142.                           where 'x' is the BBS Node number.
  143. T&J Software        <=-  (Change this to your BBS name)
  144. Tom                 <=-  (The Sysop's first name)
  145. Wildoner            <=-  (The Sysop's last name)
  146.  
  147. Example configuration file for SFDOORS.DAT
  148. ------------------------------------------
  149.  
  150. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  151. T&J Software        <=-  (Change this to your BBS name)
  152. Tom                 <=-  (The Sysop's first name)
  153. Wildoner            <=-  (The Sysop's last name)
  154.  
  155. Example configuration file for CHAIN.TXT
  156. ----------------------------------------
  157.  
  158. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  159. T&J Software        <=-  (Change this to your BBS name)
  160. Tom                 <=-  (The Sysop's first name)
  161. Wildoner            <=-  (The Sysop's last name)
  162.  
  163. Example configuration file for GTUSER.BBS
  164. -----------------------------------------
  165.  
  166. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  167. T&J Software        <=-  (Change this to your BBS name)
  168. Tom                 <=-  (The Sysop's first name)
  169. Wildoner            <=-  (The Sysop's last name)
  170. 1                   <=-  (COM port number - defaults to 1)
  171. 1                   <=-  (Node number - defaults to 1)
  172.  
  173. Example Batch File
  174. ==================
  175.  
  176. A sample batch file is included and is similer to the following:
  177.    ECHO OFF
  178.    CD\DOORS\LEMON           <=- Switch to the door's Directory.
  179.    LEMON30 LEMON.CFG        <=- Execute the door program and pass the
  180.                                 configuration filename to the program.
  181.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  182.    BOARD                    <=- Restart BBS.
  183.  
  184. This Door is multi-node  compatible so you may run more than 1 node from
  185. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  186. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  187. variables, (q.v.)
  188.  
  189. Environment Variables
  190. =====================
  191.  
  192. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  193. variables. Non-PCBoard systems may also use these variables by including
  194. the following in either your BBS batch or AUTOEXEC.BAT
  195.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  196.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  197. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  198. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  199. .CFG file for multi-node operation!
  200.  
  201. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  202. command line.  For example:
  203.  
  204.      LEMON30 LEMON.CFG /5
  205. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  206.      LEMON30 LEMON.CFG /%IRQ%
  207.  
  208. This tells the program to use IRQ 5 instead of the standard IRQ.
  209.  
  210.  
  211. Sysop Keys
  212. ==========
  213.  
  214. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  215.          written to DOOR.SYS and USERS.SYS
  216. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  217.          and/or written to DOOR.SYS and USERS.SYS
  218. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  219. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  220.          and/or written to DOOR.SYS and USERS.SYS
  221. F8    -  Returns the caller involuntarily to the BBS.
  222. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  223.          and/or written to DOOR.SYS and USERS.SYS
  224. F10   -  Activates SysOp CHAT mode within the DOOR.
  225. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  226. UP    -  Give the caller extra time while in the DOOR.  
  227. DN    -  Subtract time from the caller while in the DOOR. 
  228. HOME  -  HELP key for Status Line options.
  229. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  230. ALT-X -  PCBoard will exit after current caller logs off. Value is
  231.          passed to PCBoard. Not available on non-PCBoard systems.
  232.  
  233.  
  234.  
  235. BONUS CATAGORIES:
  236. =================
  237.  
  238. Changing the catagories in SCRAMBLE.CAT: This file contains a listing of
  239. catagories that you feel deserve BONUS points! If a word is picked and it
  240. is from this catagory, BONUS points will be awarded.
  241.  
  242. IMPORTANT!!: This file must contain 20 catagories! Simply enter a "" in
  243. the lines that do not contain data. Looking at the SCRAMBLE.CAT file will
  244. show you the proper setup. This file comes all ready for you -- As you add
  245. word lists, or new lists become available from T&J Software, you be told
  246. what to add to this file.
  247.  
  248. YOUR CONFIGURATION FILE:
  249. ========================
  250.  
  251. Change the SYSOP.CFG file to meet your needs:
  252.  
  253. 25
  254. 8
  255. 275
  256. 5
  257. N
  258. C:\WC30\BULL\BULL99.SCR
  259. C:\WC30\BULL\BULL99.BBS
  260.  
  261. LINE 1: Number of words/play a user may attempt.
  262. LINE 2: Number of WORDx.TXT files you have.
  263. LINE 3: Number of words per WORDx.TXT file.
  264. LINE 4: Current month. Used for resetting the scores monthly!
  265. LINE 5: Tournament mode (Y or N)
  266. LINE 6: Path to your color bulletin.
  267. LINE 7: Path to your ASCII bulletin.
  268.  
  269. The only items you need to set initially are lines 5, 6, and 7. The
  270. first four lines will all be configured for you. You can alter line one
  271. if you feel 25 words per play is too low or high.
  272.  
  273. TOURNAMENT MODE:
  274. ================
  275.  
  276. Turning tournament mode on does the following: The first player of the
  277. day will have to wait a few seconds until the tournament words are
  278. selected. Next, the tournament words will be compiled into a file
  279. called TOURNY.TXT. All users who play today will get the same words
  280. (scrambled differently). The tournament generator will look at your
  281. SYSOP.CFG file, look at line one (for the number of words), and will
  282. pick that number of words randomly from all your WORDx.TXT files. The
  283. tournament mode is dissabled until the door is registered.
  284.  
  285. The above file will come configured to the word lists which are shipped
  286. with the game. As you add word lists, simply change lines 2 and 3 to
  287. reflect the changes! Scramble currently ships with 2000+ words!
  288.  
  289. LOCAL MODE:
  290. ===========
  291.  
  292. To run in LOCAL mode simply run SCRAMBLE using the LOCAL.BAT file:
  293.           EXAMPLE:  LOCAL
  294.           OR: SCRAM36 LOCAL
  295.  
  296. RESETTING:
  297. ==========
  298.  
  299. Scramble will reset at the first of each month -- no maintenance
  300. needed. However, you can reset Scramble any time you wish using the
  301. RESET command string.    --->  SCRAM36 RESET
  302.  
  303. WORD LISTS:
  304. ===========
  305.  
  306. Scramble currently ships with 8 word lists -- each list contains 275
  307. words! You can have up to 50 word lists (WORD1.TXT to WORD50.TXT), but
  308. each list must have the same number of words. Let's say you make your own
  309. word list containing 275 words. This will be your 9th word list. Name
  310. your word list WORD9.TXT and place it in your SCRAMBLE directory. Next,
  311. change line 2 of your SYSOP.CFG file to 9 -- that's it, Scramble will
  312. now accept words from your word list!
  313.  
  314. If you start making word lists, please UL them to my BBS so I can
  315. incorporate them into future versions and make them available to other
  316. Scramble users to DL. If you contribute word lists, I will make some
  317. deductions from future door game registration fees for you.
  318.  
  319. VERIFYING WORD LISTS:
  320. ====================
  321.  
  322. Running Scramble with the command string VERIFY will verify your current
  323. and future word lists. Run verify by typing  SCRAM36 VERIFY
  324.  
  325. Verify will check your word lists for the following:
  326.  
  327.         1.] Words >12 characters
  328.         2.] Words <4 characters
  329.         3.] Word lists without enough words
  330.  
  331. Verify will read your SYSOP.CFG file and find how many word lists you have,
  332. it will then read your SYSOP.CFG file for the number of words per list.
  333.  
  334. Verify will generate a report called REPORT.TXT which will contain a
  335. detailed listing showing where the problems are.
  336.  
  337. If verify aborts for any reason, there is one of two problems:
  338.     1.] Your word list has too few words.
  339.     2.] There are blank lines at the end of the text file.
  340.  
  341. Correct the problems and the rerun verify.
  342.  
  343.  
  344. FUTURE VERSIONS:
  345. ================
  346.  
  347.    ---> What would you like to see added? Just let me know.
  348.  
  349. VERSION HISTORY:
  350. ================
  351.  
  352. Version 1.00 ......... First release. 2/2/91
  353. Version 1.10 ......... Maintenance update. Changed BBS name. 8/17/91
  354. Version 2.00 ......... Now using BASIC PDS v7.1, all external files
  355.                        placed inside the main code, now support WC!
  356.                        2.x and 3.x, added tournament mode. 10/1/91
  357. Version 2.10 ......... Fix for BBS running with com port unlocked.
  358.                        Other small mods made also.  02/01/92
  359. Version 3.00 ......... Converted to DoorFrame routines -- facelift
  360.                        for the program. 02/23/92
  361. Version 3.10 ......... Recompiled using newer DoorFrame routines and
  362.                        added new bulletin routines.  04-17-1992
  363. Version 3.50 ......... Cleaned the code a little, added the ability
  364.                        to view the TOP TEN while in the door, got
  365.                        rid of the SEXTRA program, made a new RESET
  366.                        program, moved tournament routines inside the
  367.                        main code. 05-16-92
  368. Version 3.60 ......... Verify and Setup have been moved into the main
  369.                        code. Door updated with the newest door routines.
  370.                        05-24-92
  371. Version 3.60 ......... Fixed small problem with Scramble not resetting
  372.                        the scores monthly. 06-06-92
  373.  
  374. That's all there is to it! If you have any problems or questions
  375. please feel free to call the T&J BBS at (717)325-9481.
  376.  
  377. Future add on word lists will be available to DL from my BBS.
  378.  
  379. See the REGISTER.TXT file for registering.
  380.  
  381. Your users will get a lot of duplicate words until the game is
  382. registered.
  383.